Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: iframe rendering optimization #35959

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

PKulkoRaccoonGang
Copy link
Contributor

@PKulkoRaccoonGang PKulkoRaccoonGang commented Dec 4, 2024

🚨 Dependencies:

Description

This PR provides iframe reload optimizations for various xblock related actions. Added some improvements related to scrolling to the current xblock. Fixed behavior of the xblock action dropdown list.

Testing instructions

  1. Open New Course Unit page.
  2. When duplicating a block, a scroll to a new copy of the block occurs.
  3. Delete, duplicate, drag xblock - a full iframe reboot should not occur.
  4. Open a new xblock editor, save the changes - after returning to the course unit page, the page should scroll to the xblock for which the changes were made.
Screen.Recording.2025-01-20.at.9.21.47.AM.mov

Other information

Improvements to the editing modals and tagging will be added in future PRs.

@PKulkoRaccoonGang PKulkoRaccoonGang self-assigned this Dec 4, 2024
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 4, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Dec 4, 2024

Thanks for the pull request, @PKulkoRaccoonGang!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

cms/static/js/views/pages/container.js Outdated Show resolved Hide resolved
cms/static/js/views/pages/container.js Outdated Show resolved Hide resolved
cms/static/js/views/pages/container.js Show resolved Hide resolved
cms/static/js/views/pages/container.js Outdated Show resolved Hide resolved
@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/rendering-optimization branch from 90e61dd to 64c4b07 Compare January 22, 2025 09:41
Comment on lines +965 to +973
return window.addEventListener(
'message',
(event) => {
if (event.data && event.data.type === 'completeXBlockDuplicating') {
return self.onNewXBlock(placeholderElement, null, true, event.data.payload);
}
},
{ once: true }
);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, sorry, now that I look at this again, I realize that { once: true } will be a problem. If an unrelated message event comes in before completeXBlockDuplicating, the listener will be called for that other message, and do nothing. But then the event handler will be unregistered. Then, when the completeXBlockDuplicating message comes in, nothing will happen.

I think you need some other approach to ensure that the event listener is only called once, either by unregistering itself within the if (event.data && event.data.type === 'completeXBlockDuplicating') { section, or add this event listener during the overall init and have it always listening rather than temporarily registering it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Status: Waiting on Author
Development

Successfully merging this pull request may close these issues.

4 participants